Skip to main content
Version: 1.6

CLI commands

Access to the system Command Line Console (CLI)​

If the installation and deployment have been successfully completed, configuration process can be applied. Run the virtual machine that has been created. In order to access the configuration panel press Left Shift button 5 times. Cmd console will pop up, there will be command line asking for a password.

For the Admin account, the default password is: FcxN12#$ (It is strongly recommended to change this password later in GUI). Network configuration status and list of CLI commands will be displayed after successful login. The list of CLI commands are presented in figure below.

The system command root folder real terminal view is displayed. Some CLI commands are used to enter into the group of commands related to them.

FlowControl command line interface (CLI) commands​

After login to CLI console the status of network configuration and the list of CLI commands should be as seen in the figure below.

Important notice:

Users will be logged out automatically after 5 minutes of inactivity.

image-20210204152917666

In the diagram below are the CLI commands structure tree related to real console view. image-20210204165400298

[status]​

The command [status] is used to display actual status of most important system parameters as shown below .

image-20200906124526482

[status- CPU configuration status] - displays information if CPU configuration is correct and how many CPU’s the system actually uses. If not check ESX configuration.

[status- CPU usage] - displays percentages of CPU’s usage.

[status- Memory usage] - displays percentages and GB numbers of free Memory and total number of Memory in GB.

[status- Drives status] - displays information on how physicals drives are configured related to free space. Status of status of drives is also shown here.

[status- Flows configuration] - displays NetFlow, sFlow port configurations.

[status- Flows status] - displays actual number of Total Packets, Total Flows, Analyzed Flows and Flow Type (NetFlows, sFlows)

[status- System status] - displays information stating if most important system elements should be working property.

The figure below shows the real CLI console view for [status] command.

image-20200818101412725

[config]​

The [config] command is used to enter the group of commands allowing changes to all of the most important system network parameters as shown below.

image-20200812111917338

image-20200812133744015

[config-interface] - The command [config-interface] is used to configure IP addresses for any interfaces connected to the FC system.

image-20200812114626095

image-20200812133929455.png

[config-interface-show] - The command [config-interface-show] is used to show detailed information of any network interfaces connected to FC system.

image-20200812133840106

[config-interface-Ethernet0] - The command [config-interface-Ethernet0] is used to configure network parameters of interface Ethernet0. Either DHCP or static IP address can be configured.

image-20200812134024868

image-20200812133958504.png

[config-interface-exit] - Exit to previous main menu.

[config-netflow] - The command [config-netflow] is used to enter groups of commands related to NetFlow, IPFIX, ASA NSEL and sFlows protocols configuration and monitoring.

image-20200813134221840

[config-netflow-show] - The command [config-netflow-show] is used to show detailed information of NetFlow port configuration.

image-20200818102159776

[config-netflow- netflow] - The command [config-netflow-netflow] is used to configure NetFlow, IPFIX ports.

image-20200812134236808

[config-netflow- sflow] - The command [config-netflow-sflow] is used to configure sFlow ports.

image-20200812134306939.png

[config-netflow- logs] - The command [config-netflow-logs] is used to enter groups of commands related to NetFlow, NSEL, sFLow logs.

image-20200812112534309

image-20200812134412961.png

[config-netflow-logs-logs] - The command [config-netflow-logs-logs] is used to show NetFlow, NSEL, sFlow engine logs.

image-20200812134546734.png

[config-netflow-logs-stats] - The command [config-netflow-logs-stats] is used to show NetFlow, NSEL, sFlow total statistics.

image-20200812134444088.png

[config-netflow-logs-exit] - Exit to previous menu.

[config-netflow-capture] - The command [config-netflow-capture] is used to enter groups of commands related to NetFlow capture packets.

image-20200812113134247.png

[config-netflow-capture-capture [interval]] - The command [config-netflow-capture-capture [interval] ] is used to start capture NetFlow packets. The interval of capture must be set in range of 1 to 600 sec. All capture information is available in FlowControl share folder \\ IP address\captures.

[config-netflow-capture-clear] - The command [config-netflow-capture-clear] is used to delete all capture files.

[config-netflow-capture-close] - The command [config-netflow-capture-logs-close] is used to close share with capture files.

[config-netflow-capture-exit] - Exit to previous menu.

[config-netflow-exit] - Exit to previous menu.

[logs]​

The command [logs] is used to enter groups of commands related to log collection management from the FlowControl System

image-20200818102231826

​ [logs-collect] - The command [logs-collect] is used to start collecting system logs and writing them to disc drive

[logs-close] - The command [logs-close] is used to stop collecting logs.

[logs-clean] - The command [logs-clean] is used to delete all logs/capture files.

[logs-exit] - Exit to previous menu.

[update]​

The command [update] is used to enter groups of commands related to FlowControl system update.

image-20200812115319103.png

[update - status] - The command [update-status] is used to show status of the system updating.

image-20200813132806219 image-20200818101412725

[update - update] - The command [update-update] is used to start update process.

[update - clean] - The command [update-clean] is used to clean update folder.

[update - exit] - Exit to main menu.

[diagnostic]​

The command [diagnostic] is used to enter groups of commands related to FlowControl network connections diagnostics.

image-20200812133129117.png

image-20200813132605621.png

[diagnostic-ping] - Run ping command.

image-20200813132550485.png

[diagnostic-tracert] - Run tracert command.

image-20200813132637681.png

[diagnostic-exit] - Exit to previous menu.

[firewall]​

The command [firewall] is used to enter groups of commands related to management of blocking/allowing incoming communication from IP addresses.

image-20200812132845871.png

image-20200812135022447.png

[firewall- show] - The command [firewall-show] is used to enter actual blocked IP addresses.

[firewall- add [RuleName][IP]] - The command [firewall- add [RuleName][IP]] is used to add rule to firewall

[firewall- delete [RuleName]] - The command [firewall- delete [RuleName]] is used to delete rule on firewall

[firewall- exit] - Exit to main menu.

[proxy]​

The command [proxy] is used to enter groups of commands related to configuration: of proxy server for FlowControl system.

image-20200812115353463.png

image-20200812134911458.png

[proxy - show] - Shows current proxy configuration

image-20200812134947414.png

[proxy-set] - The command [proxy-set] is used to set PROXY server and port.

[proxy-test[URL]] - The command [proxy-test[URL]] is used to test PROXY server connection.

[proxy-exit] - Exit to main menu.

[drive]​

The command [ drive] is used to enter groups of commands related to memory drive add, configuration and monitoring.

image-20200812132922034.png

image-20200813132505034.png

[drive-show] - Show current drive configuration

image-20200812134846697.png

[drive-add] - The command [drive-add] is used to add new drive to the system.

[drive-extend] - The command [drive-extend] is used to extend already existing memory drive.

[drive-exit] - Exit to main menu.

[backup data]​

The command [backup data] is used to copy the database with metrics to external storage media or to move the data to another Flowcontrol server. The command "backup data can also be used to restore the database.

image-20210204165556816

image-20210204153418870.png

image-20210204164711160.png

[restore defaults]​

The command [restore defaults] is used to restore the databases to default settings.

image-20210204170107797.png

20210204153648136.png

[restore defaults-erase user cache] - The command [restore defaults-erase user cache] is used to erase all users cache.

image-20210204153816725.png

[restore defaults-erase user data] - The command [restore defaults-erase user data] is used to erase all user data like: users, mappings, groups, bookmarks, network alerts, notifications, SNMP, hostnames, license and reports.

image-20210204153927393.png

[restore defaults-erase app data] - The command [restore defaults-erase app data] is used to erase all applications data including bookmarks.

image-20210204154245941.png

[restore defaults-erase database] - The command [restore defaults-erase database] is used to erase all data/metrics both from database and cache.

[restart engine]​

The command [restart engine] is used to restart FlowControl System engine.

[restart web service]​

The command [restart web service] is used to restart FlowControl System web service.

[restart other services]​

The command [restart other services] is used to restart FlowControl System other services.

[restart database]​

The command [restart database] is used to restart FlowControl System databases.

[restart server]​

The command [restart server] is used to restart FlowControl System server.

[shutdown server]​

The command [shutdown server] is used to shutdown FlowControl System server.